Skip to content

env: add zephyr support - #360

Open
RomainPelletant wants to merge 3 commits into
michaelrsweet:masterfrom
Sixtaupi:env/add-zephyr-support
Open

RomainPelletant wants to merge 3 commits into
michaelrsweet:masterfrom
Sixtaupi:env/add-zephyr-support

Conversation

@RomainPelletant

@RomainPelletant RomainPelletant commented Oct 15, 2026 •

Copy link
Copy Markdown
  • Add zephyr support (everything is located under zephyr folder)
  • Add west.yml manifest to ease integration
  • Add CI step for zephyr build

Fixes #361

Assisted-by: ChatGPT:GPT-5.6 Sol

@RomainPelletant
RomainPelletant force-pushed the env/add-zephyr-support branch 2 times, most recently from 00ac9f0 to 61e6d94 Compare October 15, 2026 14:15
@michaelrsweet michaelrsweet self-assigned this Oct 15, 2026
@michaelrsweet michaelrsweet added the investigating Investigating the issue label Oct 15, 2026
@michaelrsweet

Copy link
Copy Markdown
Owner

I will consider this. In the future, please just file a PR as issue+PR is just more work for both of us... :)

@RomainPelletant

Copy link
Copy Markdown
Author

Thank you! Noted for next time, old habits die hard :)

@michaelrsweet michaelrsweet left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments. Mainly coding style/copyright header issues, plus I'm wondering about "west.yml" in the root directory...

Comment thread west.yml
@@ -0,0 +1,17 @@
# SPDX-License-Identifier: Apache-2.0

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason this needs to be in the root directory or present at all?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

west.yml (manifest) is not mandatory but -extremely- useful for zephyr use.
It makes the repo directly usable in two commands (west init -l . && west update) to compile/run library, sample test suite and CI.
That said, if you’d prefer not to have a west manifest in the upstream repository, I can remove it.

Comment thread zephyr/samples/basic/src/main.c Outdated
@@ -0,0 +1,89 @@
/* SPDX-License-Identifier: Apache-2.0 */

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd feel more comfortable if this sample code had a proper copyright header.

#include <mxml.h>

static mxml_type_t value_type(void *cbdata, mxml_node_t *node)
{

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also (and I know I'm being anal here) any sample code should use the Mini-XML coding style - see the (newly added but largely copied from my other projects) "CONTRIBUTING.md" file that actually documents this in excruciating detail.

@RomainPelletant RomainPelletant Oct 15, 2026 •

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad: updated according to guidelines!

@@ -0,0 +1,8 @@
# SPDX-License-Identifier: Apache-2.0

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly here we should have a copyright header.

Comment thread zephyr/samples/basic/README.rst Outdated
@@ -0,0 +1,27 @@
Mini-XML basic sample

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dunno if restructured text is required/typical for Zephyr examples? The rest of Mini-XML uses markdown files for this sort of thing.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typical but not required: switched to markdown.

@@ -0,0 +1,31 @@
# SPDX-License-Identifier: Apache-2.0

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright header...

Comment thread zephyr/CMakeLists.txt Outdated
@@ -0,0 +1,34 @@
# Copyright (c) 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright header...

Comment thread zephyr/module.yml
security:
external-references:
- cpe:2.3:a:msweet:mini-xml:4.0.6:*:*:*:*:*:*:*
- pkg:github/michaelrsweet/mxml@v4.0.6

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the version number associated with a tag or just information that comes along with the source archive or checkout?

Mainly asking because "makesrcdist" will check all of the files that need version numbers updated, and if this also needs to be updated I'll add a check there as well...

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both references are static metadata and needs to be updated (release version for CPE and tag for PURL).
I didn't see the makesrcdist: new commit to implement the check added to save you time.

Comment thread zephyr/README.rst Outdated
@@ -0,0 +1,64 @@
Mini-XML Zephyr (as external module)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question as for the other .rst file...

Comment thread zephyr/version.cmake
@@ -0,0 +1,23 @@
# SPDX-License-Identifier: Apache-2.0

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright header?

- Add zephyr support as external module
- Tests and samples are located in zephyr folder to avoid propagation

Signed-off-by: Romain PELLETANT <romain.pelletant@sixtaupi.com>
- Add zephyr build in common build ci workflow

Signed-off-by: Romain PELLETANT <romain.pelletant@sixtaupi.com>
- Add two checks for version update in zephyr/module.yml

Signed-off-by: Romain PELLETANT <romain.pelletant@sixtaupi.com>
@RomainPelletant

RomainPelletant commented Oct 15, 2026 •

Copy link
Copy Markdown
Author

All header issues are fixed: I used the mxml header style.
Please let me know if the SPDX identifiers are an issue.
Thank you for the review

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

investigating Investigating the issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Zephyr support

2 participants